Skip to content

Document eUICC operation codes - #545

Merged
jonathanpeppers merged 3 commits into
mainfrom
jonathanpeppers-document-euicc-surface
Aug 16, 2026
Merged

Document eUICC operation codes#545
jonathanpeppers merged 3 commits into
mainfrom
jonathanpeppers-document-euicc-surface

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Summary

Sources

Validation

  • Parsed docs/xml/Android.Telephony.Euicc/Operation.xml as XML.
  • Confirmed CRLF line endings and zero To be added. placeholders in the scoped file (13 removed).
  • Ran git diff --check.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the XML documentation for Android.Telephony.Euicc.Operation to replace placeholder text with meaningful descriptions of eUICC operation categories as used in EuiccManager detailed error codes.

Changes:

  • Added a type-level summary/remarks explaining how operation categories map into the detailed error code structure.
  • Added per-enum-member summaries (and reference links) for all 11 Operation values.
Suppressed comments (11)

docs/xml/Android.Telephony.Euicc/Operation.xml:55

  • The member remarks blocks link to Android reference docs but don’t include the standard AOSP/CC BY 2.5 attribution paragraph that other Android.Telephony.Euicc members include. Please add it here (and similarly for the other members in this enum).
        <remarks>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/telephony/euicc/EuiccManager#OPERATION_APDU" title="Reference documentation">Java documentation for <code>android.telephony.euicc.EuiccManager.OPERATION_APDU</code>.</a>
            </format>

docs/xml/Android.Telephony.Euicc/Operation.xml:90

  • This remarks block is missing the standard AOSP/CC BY 2.5 attribution paragraph that’s present across other Android.Telephony.Euicc docs. Add it for consistency and licensing attribution.
        <remarks>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/telephony/euicc/EuiccManager#OPERATION_DOWNLOAD" title="Reference documentation">Java documentation for <code>android.telephony.euicc.EuiccManager.OPERATION_DOWNLOAD</code>.</a>
            </format>

docs/xml/Android.Telephony.Euicc/Operation.xml:125

  • This remarks block is missing the standard AOSP/CC BY 2.5 attribution paragraph used throughout Android.Telephony.Euicc docs. Add it for consistency and licensing attribution.
        <remarks>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/telephony/euicc/EuiccManager#OPERATION_EUICC_CARD" title="Reference documentation">Java documentation for <code>android.telephony.euicc.EuiccManager.OPERATION_EUICC_CARD</code>.</a>
            </format>

docs/xml/Android.Telephony.Euicc/Operation.xml:160

  • This remarks block is missing the standard AOSP/CC BY 2.5 attribution paragraph used throughout Android.Telephony.Euicc docs. Add it for consistency and licensing attribution.
        <remarks>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/telephony/euicc/EuiccManager#OPERATION_EUICC_GSMA" title="Reference documentation">Java documentation for <code>android.telephony.euicc.EuiccManager.OPERATION_EUICC_GSMA</code>.</a>
            </format>

docs/xml/Android.Telephony.Euicc/Operation.xml:195

  • This remarks block is missing the standard AOSP/CC BY 2.5 attribution paragraph used throughout Android.Telephony.Euicc docs. Add it for consistency and licensing attribution.
        <remarks>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/telephony/euicc/EuiccManager#OPERATION_HTTP" title="Reference documentation">Java documentation for <code>android.telephony.euicc.EuiccManager.OPERATION_HTTP</code>.</a>
            </format>

docs/xml/Android.Telephony.Euicc/Operation.xml:230

  • This remarks block is missing the standard AOSP/CC BY 2.5 attribution paragraph used throughout Android.Telephony.Euicc docs. Add it for consistency and licensing attribution.
        <remarks>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/telephony/euicc/EuiccManager#OPERATION_METADATA" title="Reference documentation">Java documentation for <code>android.telephony.euicc.EuiccManager.OPERATION_METADATA</code>.</a>
            </format>

docs/xml/Android.Telephony.Euicc/Operation.xml:265

  • This remarks block is missing the standard AOSP/CC BY 2.5 attribution paragraph used throughout Android.Telephony.Euicc docs. Add it for consistency and licensing attribution.
        <remarks>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/telephony/euicc/EuiccManager#OPERATION_SIM_SLOT" title="Reference documentation">Java documentation for <code>android.telephony.euicc.EuiccManager.OPERATION_SIM_SLOT</code>.</a>
            </format>

docs/xml/Android.Telephony.Euicc/Operation.xml:300

  • This remarks block is missing the standard AOSP/CC BY 2.5 attribution paragraph used throughout Android.Telephony.Euicc docs. Add it for consistency and licensing attribution.
        <remarks>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/telephony/euicc/EuiccManager#OPERATION_SMDX" title="Reference documentation">Java documentation for <code>android.telephony.euicc.EuiccManager.OPERATION_SMDX</code>.</a>
            </format>

docs/xml/Android.Telephony.Euicc/Operation.xml:335

  • This remarks block is missing the standard AOSP/CC BY 2.5 attribution paragraph used throughout Android.Telephony.Euicc docs. Add it for consistency and licensing attribution.
        <remarks>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/telephony/euicc/EuiccManager#OPERATION_SMDX_SUBJECT_REASON_CODE" title="Reference documentation">Java documentation for <code>android.telephony.euicc.EuiccManager.OPERATION_SMDX_SUBJECT_REASON_CODE</code>.</a>
            </format>

docs/xml/Android.Telephony.Euicc/Operation.xml:370

  • This remarks block is missing the standard AOSP/CC BY 2.5 attribution paragraph used throughout Android.Telephony.Euicc docs. Add it for consistency and licensing attribution.
        <remarks>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/telephony/euicc/EuiccManager#OPERATION_SWITCH" title="Reference documentation">Java documentation for <code>android.telephony.euicc.EuiccManager.OPERATION_SWITCH</code>.</a>
            </format>

docs/xml/Android.Telephony.Euicc/Operation.xml:405

  • This remarks block is missing the standard AOSP/CC BY 2.5 attribution paragraph used throughout Android.Telephony.Euicc docs. Add it for consistency and licensing attribution.
        <remarks>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/telephony/euicc/EuiccManager#OPERATION_SYSTEM" title="Reference documentation">Java documentation for <code>android.telephony.euicc.EuiccManager.OPERATION_SYSTEM</code>.</a>
            </format>

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/xml/Android.Telephony.Euicc/Operation.xml
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

@dalexsoto dalexsoto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The source XML contains the requested attribution, but ECMA2Yaml ignores <remarks> on enum fields, so all 11 member-specific reference links and notices are discarded from generated documentation. Please move the member links into publishing-supported content (for example, type-level remarks) and verify the exact generated preview no longer reports the scoped enum-remarks loss: Operation.xml.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers

jonathanpeppers commented Aug 16, 2026

Copy link
Copy Markdown
Member Author

Addressed in aa29be0: moved all 11 EuiccManager.OPERATION_* references and the AOSP/CC BY 2.5 notice from enum-field <remarks> into publishing-supported type-level <remarks>. OpenPublishing.Build passed for aa29be0 with zero errors; the scoped XML has zero enum-field remarks, all 11 official links, valid XML, preserved CRLF, and a clean git diff --check. The aggregate ECMA2Yaml_Enum_NoRemarks count is repository-wide; this scoped enum no longer contributes discarded field remarks.

@jonathanpeppers
jonathanpeppers requested review from dalexsoto and removed request for dalexsoto August 16, 2026 14:06
@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

@dalexsoto dalexsoto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The eleven operation references and attribution now live in publishing-supported type-level content and render correctly in the generated documentation.

@jonathanpeppers
jonathanpeppers merged commit e42901b into main Aug 16, 2026
3 checks passed
@jonathanpeppers
jonathanpeppers deleted the jonathanpeppers-document-euicc-surface branch August 16, 2026 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants